 |
API Documentation
|
|
|
Contains all information of the result of a map operation on a resource.
Definition: MapResult.h:12
virtual bool getAutoMipGeneration() const =0
RESOURCE_MISC_FLAG
Available misc flags for resources.
Definition: DxDefinesWrapper.h:56
virtual unsigned int getSampleCount() const =0
A description of a request to map a resource.
Definition: MapRequestDescriptor.h:12
bool isGammaCorrected() const
virtual void prepareAsCubemap()
void setTextureFormatFromString(const std::string_view &str)
virtual CPU_ACCESS_FLAG getCpuAccessRights() const =0
virtual unsigned int getMipLevels() const =0
virtual void setArraySize(unsigned int size)=0
A texture used for rendering, hosted on GPU.
Definition: Texture.h:35
virtual void unmap(const UnmapRequestDescriptor &requestDesc)=0
virtual RESOURCE_MISC_FLAG getMiscFlag() const =0
An interface to define objects that can be exported using this component.
Definition: Exportable.h:15
BIND_FLAG
Available binding flags for a resources.
Definition: DxDefinesWrapper.h:25
virtual void copyParams(const Texture &other)=0
Description of an unmap request.
Definition: UnmapRequestDescriptor.h:19
@ DEPTH_RENDER_TARGET
Used as a depth target rendering.
virtual void setTextureBinding(BIND_FLAG binding)=0
virtual FORMAT getTextureFormat() const =0
@ RENDER_TARGET
Used as a color target rendering.
USAGE
Available usage for resources. Drives the memory used for hosting the data.
Definition: DxDefinesWrapper.h:13
virtual void setMipLevels(unsigned int value)=0
virtual BIND_FLAG getTextureBinding() const =0
virtual void prepareAsTexture2d()
A node in the tree structure representing the data to export / import.
Definition: Node.h:42
virtual void setAutoMipGeneration(bool value)=0
virtual void importClassFromTree(nkExport::Node *rootNode) override
virtual USAGE getTextureUsage() const =0
void setCpuData(const ResourceCpuDataDescriptor &data)
ResourceCpuDataDescriptor * getCpuData() const
virtual void freeCpuData(bool freeDataPtr)
TEX_TYPE
The type a texture can be.
Definition: Texture.h:12
virtual void setHeight(unsigned int height)=0
virtual int getWidth() const =0
virtual void setDepth(unsigned int depth)=0
Describes data on the cpu, to be uploaded to the gpu.
Definition: ResourceCpuDataDescriptor.h:12
TEX_TYPE getTexType() const
virtual void setGammaCorrected(bool value)
virtual void setTextureFormat(FORMAT format)=0
virtual void exportClassToTree(nkExport::Node *rootNode) override
virtual unsigned int getSampleQuality() const =0
bool isBackBufferTex() const
CPU_ACCESS_FLAG
Available cpu access flags.
Definition: DxDefinesWrapper.h:44
virtual void setTextureUsage(USAGE usage)=0
virtual void setWidth(unsigned int width)=0
virtual void setRenderFlag(TEX_RENDER_FLAG value)
void setBackBufferTex(bool value)
@ NO_RENDER
Not used as a target.
virtual void setCpuAccessRights(CPU_ACCESS_FLAG rights)=0
virtual int getDepthOrArraySize() const =0
unsigned int getNeededMipsForSize() const
FORMAT
Available formats for resources.
Definition: DxDefinesWrapper.h:155
TEX_RENDER_FLAG getRenderFlag() const
virtual void prepareAsTexture3d()
virtual void setResourcePath(const std::string_view &path) override
Encompasses all API of component NilkinsGraphics.
Definition: BoundingBox.h:7
virtual MapResult map(const MapRequestDescriptor &requestDesc)=0
Holds information about a resource copy happening on the GPU only.
Definition: ResourceGpuCopyDescriptor.h:12
TEX_RENDER_FLAG
The render flag possible for a texture.
Definition: Texture.h:22
virtual int getHeight() const =0
virtual void gpuCopyFrom(Texture &other, const ResourceGpuCopyDescriptor &descriptor)=0
virtual bool preLoadFromFile()=0
Base class for shader resources. Those are resources that can be fed to a Shader.
Definition: ShaderResource.h:12